Add release checklist and changelog-driven release notes - #33
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: c4fe21080e
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| if [ -z "$CHANGELOG" ]; then | ||
| echo "Missing CHANGELOG.md entry for version $VERSION" >&2 | ||
| exit 1 |
There was a problem hiding this comment.
Keep the release job compatible with
make bump-*
This hard failure breaks the repository's existing bump-and-tag flow. The documented bump targets in Makefile:165-177 still call commit-and-tag-version, and the repo's own generated release commit (86683a6) shows that helper can create a ## <version> heading with no body at all under this commit history. In that case awk returns an empty string here, so the tag push passes tests but the GitHub Release job aborts. Either the bump helper/config needs to stop auto-generating the changelog/tag, or this step needs a fallback instead of exit 1.
Useful? React with 👍 / 👎.
c4fe210 to
9d72506
Compare
Closes #14.
Summary
RELEASE.mdchecklist for public releasesCHANGELOG.mdmaintainable with anUnreleasedsection and real release entriesCHANGELOG.mdand fail if the version entry is missing